Skip to main content
GET
/
v1
/
customers
/
{id}
/
usage
/
{aggregator_id}
Get customer usage for an aggregator
curl --request GET \
  --url https://api.hyperline.co/v1/customers/{id}/usage/{aggregator_id} \
  --header 'Authorization: Bearer <token>'
{
  "aggregator_id": "<string>",
  "total": 123,
  "count": 123,
  "period_start": "<string>",
  "period_end": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required
​
aggregator_id
string
required

Query Parameters

​
start_date
string<date-time>
required

ISO-8601 date string.

Example:

"2026-01-01T00:00:00Z"

​
end_date
string<date-time>
required

ISO-8601 date string.

Example:

"2026-02-01T00:00:00Z"

Response

​
aggregator_id
string
required

Aggregator ID.

​
total
number
required

Total usage over the period.

​
count
number
required

Number of events behind the total.

​
period_start
string
required

Period start (ISO-8601).

​
period_end
string
required

Period end (ISO-8601).